feat(mgmt): add engine management API#757
Merged
Merged
Conversation
Add descopeClient.management.engine with create / update / delete / load / loadAll / rotateSecret, mirroring the other management resources. Engines are managed via the management API (e.g. by the Terraform provider); see descope/backend#1614 for the backend endpoints. The engine secret is returned only by create and rotateSecret — load/loadAll never include it. Engine numeric fields are typed as string because the management gateway serializes proto int64 values as JSON strings. Includes the engine module, paths, types, management wiring, README docs, and unit tests. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
🐕 Review complete — View session on Shuni Portal 🐾 |
🐕 Suggested ReviewersThe review assignment strategy prioritized recent contributors to files directly involved in the management API and related modules. This ensures reviewers are familiar with the latest changes and the specific areas impacted by this PR.
Suggested by Shuni based on git history and PR context. Names are not @-mentioned to avoid notifying anyone — request a review from whoever fits best. |
![shuni-bot-dev[bot]](https://avatars.githubusercontent.com/u/97479186?s=60&v=4){kind=small}
There was a problem hiding this comment.
🐕 Shuni's Review
Adds management.engine with create/update/delete/load/loadAll/rotateSecret, types, paths, README, and full unit tests.
No issues found — good bones! Clean wrapper that mirrors the existing managementKey pattern, secret handling matches documented backend behavior, and all six methods are tested. Woof!
Match the dedicated management Engine message (descope/backend#1614): drop the EngineService-internal fields (projectId, version, modifiedTime, lastSync, imageVersion, contentVersion) that are no longer returned. createdTime is now a numeric epoch-seconds value. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
descopeClient.management.enginewith:create(name)→ returns the new engine incl. its generated id and secretupdate(id, name)delete(id)load(id)/loadAll()— secret is always emptyrotateSecret(id)→ returns the new secret (previous one invalidated)Engines are managed via the management API (e.g. by the Terraform provider). The backend management endpoints live in descope/backend#1614.
Notes
createandrotateSecret;load/loadAllnever include it (matches backend behavior).Enginenumeric fields (version/createdTime/...) are typedstringbecause the management gateway serializes proto int64 as JSON strings.Includes
lib/management/engine.ts, paths,Engine/EngineSecretResponsetypes, management wiring (index.ts), README section, and unit tests.Testing
eslint+prettierclean,npm run build(types) clean🤖 Generated with Claude Code